aclp region and group_by changes by pmajali · Pull Request #807 · linode/linodego

pmajali · 2025-08-25T17:19:04Z

📝 Description

Adding Monitor in the regions endpoint. This specifies the monitor services enabled in a particular region.
Adding group_by and filters field to the dashboard widget.
Enhancing services endpoint to include alert

✔️ How to Test

package main

import (
	"context"
	"fmt"
	"log"
	"net/http"
	"os"

	"github.com/linode/linodego"

	"golang.org/x/oauth2"
)

func main() {
	apiKey, ok := os.LookupEnv("LINODE_TOKEN")
	if !ok {
		log.Fatal("Could not find LINODE_TOKEN, please assert it is set.")
	}
	tokenSource := oauth2.StaticTokenSource(&oauth2.Token{AccessToken: apiKey})

	oauth2Client := &http.Client{
		Transport: &oauth2.Transport{
			Source: tokenSource,
		},
	}

	linodeClient := linodego.NewClient(oauth2Client)
	linodeClient.SetDebug(true)

	res, err := linodeClient.ListMonitorServices(context.Background(), nil)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%v", res)

	res, err := linodeClient.ListRegions(context.Background(), nil)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%v", res)
}

How do I run the relevant unit/integration tests?

unit tests
make test-unit TEST_ARGS="-run TestListMonitorServices"
make test-unit TEST_ARGS="-run TestListMonitorDashboards"
make test-unit TEST_ARGS="-run TestListRegions"

Integration test
make test-int TEST_ARGS="-run TestMonitorServices_Get_smoke"
make test-int TEST_ARGS="-run TestMonitorDashboards_Get_smoke"
make test-int TEST_ARGS="-run TestRegionsMonitorsSection"

monitor_dashboards.go

monitor_metrics_definitions.go

pmajali · 2025-09-03T13:36:14Z

An integration test for region 'TestRegions_pgLimits' is failing because the code expects 'Placement Group' not to be present at index 0, which ideally is not the case. I'm not sure why it was written this way, so haven't modified it.

	regionIdx := slices.IndexFunc(regions, func(region linodego.Region) bool {
		return slices.Contains(region.Capabilities, "Placement Group")
	})
	require.NotZero(t, regionIdx)

Copilot

Pull Request Overview

This PR enhances the monitoring capabilities of the Linode API client by adding monitor services to region information and extending dashboard widget functionality. The changes support ACLP (Analytics, Control Plane) monitoring features.

Adds Monitors field to regions containing supported alert and metrics services
Extends dashboard widgets with group_by and filters fields for better data aggregation
Enhances monitor services to include alert configuration details

Reviewed Changes

Copilot reviewed 23 out of 24 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
test/unit/region_test.go	Added tests for monitors field in region responses
test/unit/monitor_services_test.go	Enhanced tests for alert details and fixed service type tests
test/unit/monitor_dashboards_test.go	Added tests for group_by and filters widget fields
test/unit/fixtures/*.json	Updated fixtures with monitors data, alert configurations, and widget fields
test/integration/regions_test.go	Added integration test for monitors section validation
test/integration/monitor_services_test.go	Enhanced service validation and test structure
test/integration/monitor_dashboards_test.go	Added widget field validation for group_by and filters
test/integration/fixtures/*.yaml	Updated integration fixtures with monitors data

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

test/unit/monitor_services_test.go

test/unit/fixtures/monitor_services.json

test/unit/fixtures/monitor_dashboards.json

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull Request Overview

Copilot reviewed 23 out of 24 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

test/unit/monitor_dashboards_test.go

monitor_services.go

yec-akamai · 2025-09-22T15:38:52Z

Can you please fix the lint issue reported by the workflow?

Copilot

Pull Request Overview

Copilot reviewed 24 out of 25 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

yec-akamai · 2025-09-23T16:07:38Z

The lint issue is not fixed: https://github.com/linode/linodego/actions/runs/17945547628/job/51053708173?pr=807

Looks just some format issues. Could you run make lint locally to identify and fix the issues?

pmajali · 2025-09-24T06:12:07Z

https://github.com/linode/linodego/actions/runs/17945547628/job/51053708173?pr=807

I dont see lint issues related to monitor changes.

yec-akamai · 2025-09-25T14:19:56Z

https://github.com/linode/linodego/actions/runs/17945547628/job/51053708173?pr=807

I dont see lint issues related to monitor changes.

We recently updated the linter so it generated some new requirements. You can have them fixed by merging the main and fix the conflicts correspondingly.

test/integration/regions_test.go

test/integration/fixtures/TestRegions_List.yaml

test/integration/fixtures/TestRegions_pgLimits.yaml

test/integration/fixtures/TestRegions_blockStorageEncryption.yaml

test/integration/fixtures/TestRegions_kubernetesEnterprise.yaml

test/integration/fixtures/TestRegionsAvailability_List.yaml

yec-akamai

Nice work!

Copilot

Pull Request Overview

Copilot reviewed 20 out of 25 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-09T16:20:30Z

monitor_services.go

+// GetMonitorServiceByType gets a monitor service by a given service_type
+func (c *Client) GetMonitorServiceByType(ctx context.Context, serviceType string) (MonitorService, error) {
 	e := formatAPIPath("monitor/services/%s", serviceType)
-	return getPaginatedResults[MonitorService](ctx, c, e, opts)
+
+	result, err := doGETRequest[MonitorService](ctx, c, e)
+
+	if result == nil {
+		return MonitorService{}, err
+	}
+
+	return *result, err
 }


The function now returns a single MonitorService instead of a list, but the API path and behavior should be validated. Consider documenting this breaking change from ListMonitorServiceByType to GetMonitorServiceByType in the commit message or PR description.

The solution more consistent with our standards would be to make this function return a pointer (*MonitorService) returning the results of doGETRequest directly 👍

monitor_dashboards.go

lgarber-akamai

This looks great, thank you for the contribution!
Once #807 (comment) has been addressed this should be ready to go 🎉

aclp region and group_by changes

6f000a2

pmajali requested a review from a team as a code owner August 25, 2025 17:19

pmajali requested review from lgarber-akamai and zliang-akamai and removed request for a team August 25, 2025 17:19

zliang-akamai reviewed Sep 3, 2025

View reviewed changes

monitor_dashboards.go Outdated Show resolved Hide resolved

zliang-akamai reviewed Sep 3, 2025

View reviewed changes

monitor_metrics_definitions.go Outdated Show resolved Hide resolved

lint and review updates

8ff220d

pmajali and others added 2 commits September 3, 2025 19:08

Merge branch 'main' into aclp-region

42b73c0

Merge branch 'main' into aclp-region

30a80a9

zliang-akamai requested a review from Copilot September 3, 2025 20:38

Copilot AI reviewed Sep 3, 2025

View reviewed changes

test/unit/monitor_services_test.go Outdated Show resolved Hide resolved

test/unit/fixtures/monitor_services.json Outdated Show resolved Hide resolved

test/unit/fixtures/monitor_dashboards.json Outdated Show resolved Hide resolved

pmajali and others added 6 commits September 4, 2025 09:19

Update test/unit/fixtures/monitor_dashboards.json

1a05ed7

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

removing extra spaces

9aa2315

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update test/unit/fixtures/monitor_services.json

d687f5f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge branch 'main' into aclp-region

3fe5cc6

Merge branch 'main' into aclp-region

750d24d

Merge branch 'main' into aclp-region

e0ebd91

zliang-akamai requested a review from Copilot September 11, 2025 17:08

Copilot AI reviewed Sep 11, 2025

View reviewed changes

test/unit/monitor_dashboards_test.go Outdated Show resolved Hide resolved

test/unit/monitor_dashboards_test.go Show resolved Hide resolved

yec-akamai reviewed Sep 11, 2025

View reviewed changes

monitor_services.go Outdated Show resolved Hide resolved

lint and review updates

269fcf9

yec-akamai reviewed Sep 18, 2025

View reviewed changes

monitor_services.go Outdated Show resolved Hide resolved

updating getByserviceType func

7b0b368

fixing lint errors

4781ae4

Copilot AI review requested due to automatic review settings September 23, 2025 12:03

Merge branch 'main' into aclp-region

fd908f6

Copilot AI reviewed Sep 23, 2025

View reviewed changes

linode deleted a comment from Copilot AI Sep 23, 2025

Merge branch 'main' into aclp-region

d002a7d